Clarified activate_time docs.

Fri Aug 17 11:36:29 2007  Tim Janik  <timj@imendio.com>

        * gtk/gtkmenu.c (gtk_menu_popup): Clarified activate_time docs.

svn path=/trunk/; revision=18643

diff --git a/ChangeLog b/ChangeLog
index 09f3c33012388384c0c3b5868cb635286b5dd761..0e068f87f7b714c3f4268b551aad8146260ddc00 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,7 @@
+Fri Aug 17 11:36:29 2007  Tim Janik  <timj@imendio.com>
+
+       * gtk/gtkmenu.c (gtk_menu_popup): Clarified activate_time docs.
+
 2007-08-16  Cody Russell  <bratsche@gnome.org>
 
        * gdk/win32/cursor.bdf: Committing changes to the source

diff --git a/gtk/gtkmenu.c b/gtk/gtkmenu.c
index 6e99ce0bf1cda3b8cf95e2ff0c3f56f7cb3b8324..7d44efbfd30ac41f75000cee5f275df64472ccc9 100644 (file)
--- a/gtk/gtkmenu.c
+++ b/gtk/gtkmenu.c
@@ -1251,10 +1251,12 @@ popup_grab_on_window (GdkWindow *window,
  * a mouse button press, such as a mouse button release or a keypress,
  * @button should be 0.
  *
- * The @activate_time parameter should be the time stamp of the event that
- * initiated the popup. If such an event is not available, use
- * gtk_get_current_event_time() instead.
- *
+ * The @activate_time parameter is used to conflict-resolve initiation of
+ * concurrent requests for mouse/keyboard grab requests. To function
+ * properly, this needs to be the time stamp of the user event (such as
+ * a mouse click or key press) that caused the initiation of the popup.
+ * Only if no such event is available, gtk_get_current_event_time() can
+ * be used instead.
  */
 void
 gtk_menu_popup (GtkMenu                    *menu,